home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / sgesvd.z / sgesvd
Text File  |  1996-03-14  |  6KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSGGGGEEEESSSSVVVVDDDD((((3333FFFF))))                                                          SSSSGGGGEEEESSSSVVVVDDDD((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SGESVD - compute the singular value decomposition (SVD) of a real M-by-N
  10.      matrix A, optionally computing the left and/or right singular vectors
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SGESVD( JOBU, JOBVT, M, N, A, LDA, S, U, LDU, VT, LDVT, WORK,
  14.                         LWORK, INFO )
  15.  
  16.          CHARACTER      JOBU, JOBVT
  17.  
  18.          INTEGER        INFO, LDA, LDU, LDVT, LWORK, M, N
  19.  
  20.          REAL           A( LDA, * ), S( * ), U( LDU, * ), VT( LDVT, * ), WORK(
  21.                         * )
  22.  
  23. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  24.      SGESVD computes the singular value decomposition (SVD) of a real M-by-N
  25.      matrix A, optionally computing the left and/or right singular vectors.
  26.      The SVD is written
  27.  
  28.           A = U * SIGMA * transpose(V)
  29.  
  30.      where SIGMA is an M-by-N matrix which is zero except for its min(m,n)
  31.      diagonal elements, U is an M-by-M orthogonal matrix, and V is an N-by-N
  32.      orthogonal matrix.  The diagonal elements of SIGMA are the singular
  33.      values of A; they are real and non-negative, and are returned in
  34.      descending order.  The first min(m,n) columns of U and V are the left and
  35.      right singular vectors of A.
  36.  
  37.      Note that the routine returns V**T, not V.
  38.  
  39.  
  40. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  41.      JOBU    (input) CHARACTER*1
  42.              Specifies options for computing all or part of the matrix U:
  43.              = 'A':  all M columns of U are returned in array U:
  44.              = 'S':  the first min(m,n) columns of U (the left singular
  45.              vectors) are returned in the array U; = 'O':  the first min(m,n)
  46.              columns of U (the left singular vectors) are overwritten on the
  47.              array A; = 'N':  no columns of U (no left singular vectors) are
  48.              computed.
  49.  
  50.      JOBVT   (input) CHARACTER*1
  51.              Specifies options for computing all or part of the matrix V**T:
  52.              = 'A':  all N rows of V**T are returned in the array VT;
  53.              = 'S':  the first min(m,n) rows of V**T (the right singular
  54.              vectors) are returned in the array VT; = 'O':  the first min(m,n)
  55.              rows of V**T (the right singular vectors) are overwritten on the
  56.              array A; = 'N':  no rows of V**T (no right singular vectors) are
  57.              computed.
  58.  
  59.              JOBVT and JOBU cannot both be 'O'.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSGGGGEEEESSSSVVVVDDDD((((3333FFFF))))                                                          SSSSGGGGEEEESSSSVVVVDDDD((((3333FFFF))))
  71.  
  72.  
  73.  
  74.      M       (input) INTEGER
  75.              The number of rows of the input matrix A.  M >= 0.
  76.  
  77.      N       (input) INTEGER
  78.              The number of columns of the input matrix A.  N >= 0.
  79.  
  80.      A       (input/output) REAL array, dimension (LDA,N)
  81.              On entry, the M-by-N matrix A.  On exit, if JOBU = 'O',  A is
  82.              overwritten with the first min(m,n) columns of U (the left
  83.              singular vectors, stored columnwise); if JOBVT = 'O', A is
  84.              overwritten with the first min(m,n) rows of V**T (the right
  85.              singular vectors, stored rowwise); if JOBU .ne. 'O' and JOBVT
  86.              .ne. 'O', the contents of A are destroyed.
  87.  
  88.      LDA     (input) INTEGER
  89.              The leading dimension of the array A.  LDA >= max(1,M).
  90.  
  91.      S       (output) REAL array, dimension (min(M,N))
  92.              The singular values of A, sorted so that S(i) >= S(i+1).
  93.  
  94.      U       (output) REAL array, dimension (LDU,UCOL)
  95.              (LDU,M) if JOBU = 'A' or (LDU,min(M,N)) if JOBU = 'S'.  If JOBU =
  96.              'A', U contains the M-by-M orthogonal matrix U; if JOBU = 'S', U
  97.              contains the first min(m,n) columns of U (the left singular
  98.              vectors, stored columnwise); if JOBU = 'N' or 'O', U is not
  99.              referenced.
  100.  
  101.      LDU     (input) INTEGER
  102.              The leading dimension of the array U.  LDU >= 1; if JOBU = 'S' or
  103.              'A', LDU >= M.
  104.  
  105.      VT      (output) REAL array, dimension (LDVT,N)
  106.              If JOBVT = 'A', VT contains the N-by-N orthogonal matrix V**T; if
  107.              JOBVT = 'S', VT contains the first min(m,n) rows of V**T (the
  108.              right singular vectors, stored rowwise); if JOBVT = 'N' or 'O',
  109.              VT is not referenced.
  110.  
  111.      LDVT    (input) INTEGER
  112.              The leading dimension of the array VT.  LDVT >= 1; if JOBVT =
  113.              'A', LDVT >= N; if JOBVT = 'S', LDVT >= min(M,N).
  114.  
  115.      WORK    (workspace/output) REAL array, dimension (LWORK)
  116.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK; if INFO
  117.              > 0, WORK(2:MIN(M,N)) contains the unconverged superdiagonal
  118.              elements of an upper bidiagonal matrix B whose diagonal is in S
  119.              (not necessarily sorted). B satisfies A = U * B * VT, so it has
  120.              the same singular values as A, and singular vectors related by U
  121.              and VT.
  122.  
  123.      LWORK   (input) INTEGER
  124.              The dimension of the array WORK. LWORK >= 1.  LWORK >=
  125.              MAX(3*MIN(M,N)+MAX(M,N),5*MIN(M,N)-4).  For good performance,
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSGGGGEEEESSSSVVVVDDDD((((3333FFFF))))                                                          SSSSGGGGEEEESSSSVVVVDDDD((((3333FFFF))))
  137.  
  138.  
  139.  
  140.              LWORK should generally be larger.
  141.  
  142.      INFO    (output) INTEGER
  143.              = 0:  successful exit.
  144.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  145.              > 0:  if SBDSQR did not converge, INFO specifies how many
  146.              superdiagonals of an intermediate bidiagonal form B did not
  147.              converge to zero. See the description of WORK above for details.
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.